Window handling. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/display/kzs_surface_configuration.h>
#include <system/display/kzs_native_handles.h>
#include <system/kzs_header.h>

Classes
struct	KzsWindowProperties
	Properties for a window. More...

Enumerations
enum	KzsDisplayOrientationAngle { KZS_DISPLAY_ORIENTATION_ANGLE_0, KZS_DISPLAY_ORIENTATION_ANGLE_180 }
	List of window orientation angles. More...

enum	KzsWindowStyle { KZS_WINDOW_STYLE_FIXED, KZS_WINDOW_STYLE_RESIZABLE, KZS_WINDOW_STYLE_FULL_SCREEN, KZS_WINDOW_STYLE_BORDERLESS, KZS_WINDOW_STYLE_STUDIO_PREVIEW, KZS_WINDOW_STYLE_DEFAULT }
	Enumeration for different window styles. More...

Functions
KANZI_API kzsError	kzsWindowCreateFromNative (struct KzsWindowNative windowNative, struct KzsWindow *out_window)
	Creates a window with a previously created native window. More...

KANZI_API kzsError	kzsWindowCreate (const struct KzsDesktop desktop, const struct KzsDisplay display, const struct KzsWindowProperties windowPropertiesRequested, const struct KzsSurfaceConfiguration configuration, struct KzsWindow **out_window)
	Creates a window and returns it. More...

KANZI_API kzsError	kzsWindowCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop desktop, struct KzsWindow *out_window)
	Creates a window from a native handle. More...

KANZI_API kzsError	kzsWindowDelete (struct KzsWindow *window)
	Deletes a window. More...

KANZI_API kzsError	kzsWindowResize (const struct KzsWindow *window, kzUint width, kzUint height)
	Resizes the window. More...

KANZI_API kzsError	kzsWindowSetPositionAbsolute (const struct KzsWindow *window, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform. More...

KANZI_API kzsError	kzsWindowShow (struct KzsWindow *window)
	Makes newly created window visible. More...

KANZI_API kzsError	kzsWindowSetTitle (const struct KzsWindow *window, kzString titleText)
	Sets the title bar string for the window, if supported by the platform. More...

KANZI_API kzUint	kzsWindowGetCurrentWidth (const struct KzsWindow *window)
	Gets the width of the window. More...

KANZI_API kzUint	kzsWindowGetCurrentHeight (const struct KzsWindow *window)
	Gets the height of the window. More...

KANZI_API struct KzsWindowNative *	kzsWindowGetNative (const struct KzsWindow *window)
	Gets the native window. More...

KANZI_API kzsError	kzsWindowNativeCreate (const struct KzsDesktop desktop, const struct KzsDisplay display, const struct KzsWindowProperties windowPropertiesRequested, const struct KzsSurfaceConfigurationNative configurationNative, struct KzsWindowProperties out_windowProperties, struct KzsWindowNative *out_windowNative)
	Creates a native window. More...

KANZI_API kzsError	kzsWindowNativeCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop desktop, struct KzsWindowProperties out_windowProperties, struct KzsWindowNative **out_windowNative)
	Creates a native window from a native handle. More...

KANZI_API kzsError	kzsWindowNativeInitialize (struct KzsWindowNative windowNative, struct KzsWindow window)
	Initializes window. More...

KANZI_API kzsError	kzsWindowNativeDelete (struct KzsWindowNative *windowNative)
	Deletes a native window. More...

KANZI_API kzsError	kzsWindowNativeResize (const struct KzsWindowNative *windowNative, kzUint width, kzUint height)
	Resizes the window. More...

KANZI_API kzsError	kzsWindowNativeSetPositionAbsolute (const struct KzsWindowNative *windowNative, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform. More...

KANZI_API kzsError	kzsWindowNativeShow (struct KzsWindowNative *windowNative)
	Makes newly created window visible. More...

KANZI_API kzsError	kzsWindowNativeSetTitle (const struct KzsWindowNative *windowNative, kzString titleText)
	Sets the title bar string for the window, if supported by the platform. More...

KANZI_API kzUint	kzsWindowNativeGetCurrentWidth (const struct KzsWindowNative *windowNative)
	Gets the width of the window. More...

KANZI_API kzUint	kzsWindowNativeGetCurrentHeight (const struct KzsWindowNative *windowNative)
	Gets the height of the window. More...

KANZI_API kzsError	kzsWindowNativeSetOrder (const struct KzsWindowNative *windowNative, kzInt order)
	Sets the window Z order, if supported by the platform. More...

KANZI_API kzsError	kzsWindowPropertiesLog (const struct KzsWindowProperties *properties)
	Outputs the window properties to the log. More...

KANZI_API void	kzsWindowLogProperties (const struct KzsWindow *window)
	Outputs the properties of the window to the log. More...

Variables
const kzInt	KZS_WINDOW_POSITION_DEFAULT
	Platform-specific default position for a window. More...

Detailed Description

Window handling.

Enumeration Type Documentation

enum KzsDisplayOrientationAngle

List of window orientation angles.

Enumerator
KZS_DISPLAY_ORIENTATION_ANGLE_0	0 degrees.
KZS_DISPLAY_ORIENTATION_ANGLE_180	180 degrees.

enum KzsWindowStyle

Enumeration for different window styles.

Enumerator
KZS_WINDOW_STYLE_FIXED	A window that cannot be resized.
KZS_WINDOW_STYLE_RESIZABLE	A window that can be resized.
KZS_WINDOW_STYLE_FULL_SCREEN	Window occupies the whole screen.
KZS_WINDOW_STYLE_BORDERLESS	No borders or other decorations.
KZS_WINDOW_STYLE_STUDIO_PREVIEW	Docked window with external message handling. Should only be used by Kanzi Studio.
KZS_WINDOW_STYLE_DEFAULT	Let the system choose the appropriate window style for the platform.

Function Documentation

KANZI_API kzsError kzsWindowCreateFromNative	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow **	out_window
	)

Creates a window with a previously created native window.

Takes ownership of the native window.

KANZI_API kzsError kzsWindowCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct KzsWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfiguration *	configuration,
		struct KzsWindow **	out_window
	)

Creates a window and returns it.

KANZI_API kzsError kzsWindowCreateWrapper	(	NativeWindowHandle	windowHandle,
		const struct KzsDesktop *	desktop,
		struct KzsWindow **	out_window
	)

Creates a window from a native handle.

KANZI_API kzsError kzsWindowDelete ( struct KzsWindow * window )

Deletes a window.

KANZI_API kzsError kzsWindowResize	(	const struct KzsWindow *	window,
		kzUint	width,
		kzUint	height
	)

Resizes the window.

KANZI_API kzsError kzsWindowSetPositionAbsolute	(	const struct KzsWindow *	window,
		kzUint	x,
		kzUint	y
	)

Sets the absolute position the window, if supported by the platform.

KANZI_API kzsError kzsWindowShow ( struct KzsWindow * window )

Makes newly created window visible.

KANZI_API kzsError kzsWindowSetTitle	(	const struct KzsWindow *	window,
		kzString	titleText
	)

Sets the title bar string for the window, if supported by the platform.

KANZI_API kzUint kzsWindowGetCurrentWidth ( const struct KzsWindow * window )

Gets the width of the window.

KANZI_API kzUint kzsWindowGetCurrentHeight ( const struct KzsWindow * window )

Gets the height of the window.

KANZI_API struct KzsWindowNative* kzsWindowGetNative ( const struct KzsWindow * window )

Gets the native window.

KANZI_API kzsError kzsWindowNativeCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct KzsWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfigurationNative *	configurationNative,
		struct KzsWindowProperties *	out_windowProperties,
		struct KzsWindowNative **	out_windowNative
	)

Creates a native window.

KANZI_API kzsError kzsWindowNativeCreateWrapper	(	NativeWindowHandle	windowHandle,
		const struct KzsDesktop *	desktop,
		struct KzsWindowProperties *	out_windowProperties,
		struct KzsWindowNative **	out_windowNative
	)

Creates a native window from a native handle.

KANZI_API kzsError kzsWindowNativeInitialize	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow *	window
	)

Initializes window.

Called after creating window and native window.

KANZI_API kzsError kzsWindowNativeDelete ( struct KzsWindowNative * windowNative )

Deletes a native window.

KANZI_API kzsError kzsWindowNativeResize	(	const struct KzsWindowNative *	windowNative,
		kzUint	width,
		kzUint	height
	)

Resizes the window.

Native implementation.

KANZI_API kzsError kzsWindowNativeSetPositionAbsolute	(	const struct KzsWindowNative *	windowNative,
		kzUint	x,
		kzUint	y
	)

Sets the absolute position the window, if supported by the platform.

Native implementation.

KANZI_API kzsError kzsWindowNativeShow ( struct KzsWindowNative * windowNative )

Makes newly created window visible.

KANZI_API kzsError kzsWindowNativeSetTitle	(	const struct KzsWindowNative *	windowNative,
		kzString	titleText
	)

Sets the title bar string for the window, if supported by the platform.

Native implementation.

KANZI_API kzUint kzsWindowNativeGetCurrentWidth ( const struct KzsWindowNative * windowNative )

Gets the width of the window.

KANZI_API kzUint kzsWindowNativeGetCurrentHeight ( const struct KzsWindowNative * windowNative )

Gets the height of the window.

KANZI_API kzsError kzsWindowNativeSetOrder	(	const struct KzsWindowNative *	windowNative,
		kzInt	order
	)

Sets the window Z order, if supported by the platform.

KANZI_API kzsError kzsWindowPropertiesLog ( const struct KzsWindowProperties * properties )

Outputs the window properties to the log.

KANZI_API void kzsWindowLogProperties ( const struct KzsWindow * window )

Outputs the properties of the window to the log.

Variable Documentation

const kzInt KZS_WINDOW_POSITION_DEFAULT

Platform-specific default position for a window.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation